/*
 * Copyright 2002-2006 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.tigris.mappedlexer.io;

/**
 * Operation conventions for character output sequence.
 * 
 * @author Sam Huang
 *
 */
public interface CharOutputSequence {
	
	/**
	 * Add a character to the end of the sequence.
	 * 
	 * @param chr the character to be added
	 * 
	 */
	public void append(char chr);
	
	/**
	 * Add a string to the end of the sequence.
	 * 
	 * @param stream the string to be added
	 */
	public void append(String stream);
	
	/**
	 * Add a character to the beginning of the sequence.
	 * 
	 * @param chr the character to be added
	 * 
	 */
	public void prepend(char chr);
	
	/**
	 * Close the sequence.
	 *
	 */
	public void close();
	
	/**
	 * Add a string to the beginning of the sequence.
	 * 
	 * @param stream the string to be added
	 */
	public void prepend(String stream);
	
	/**
	 * Return the string representation of the sequence.
	 * 
	 * @return the sequence in string
	 */
	public String toString();
}
